# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your MultiworldGG options are valid at this site:
#        https://multiworld.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Peaks of Yore Template

game: Peaks of Yore
requires:
  version: 0.7.55 # Version of MultiworldGG required for this yaml to work as expected.

Peaks of Yore:
  # Game Options
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0
    random-high: 0
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  death_link:
    # When you die, everyone who enabled death link dies. Of course, the reverse is true too.
    'false': 50
    'true': 0

  goal:
    # Decide what needs to happen to be counted as a win
    # 
    # - **All Peaks**: Finish all peaks in selected books to win/complete your run
    # - **All Artefacts**: Collect all artefacts on selected peaks
    # - **All Artefacts All Peaks**: complete both of the above
    # - **Time Attack**: Complete All time, rope and hold challenges
    # - **All**: all items including bird seeds and ropes
    all_peaks: 50
    all_artefacts: 0
    all_artefacts_all_peaks: 0
    time_attack: 0
    all: 0

  # Starting Items
  starting_book:
    # Choose what book to start with. If the book is not enabled, the easiest enabled book will be chosen.
    # 
    # If the selected book is disabled, a random enabled book will be chosen.
    fundamentals: 50
    intermediate: 0
    advanced: 0
    expert: 0

  start_with_barometer:
    # Choose to start with the barometer, to locate items quicker
    'false': 0
    'true': 50

  start_with_oil_lamp:
    # Choose whether the Aldr Grotto oil lamp is given at the start.
    # Also works with the Idol of Sundown.
    'false': 50
    'true': 0

  rope_unlock_mode:
    # Choose when the rope unlock item is given
    # 
    # - **Instant**: Unlock ropes as soon as you receive them
    # - **Early**: Try to unlock the item early on in the game
    # - **Normal**: Do not put rope unlock earlier and randomise it like any other item
    instant: 0
    early: 50
    normal: 0

  start_with_hands:
    # Choose what hands you want to have enabled on start.
    # WARNING: Setting this to any setting other than *both* can make the game **very** difficult!
    both: 50
    left: 0
    right: 0

  early_hands:
    # Choose whether the missing hand will be placed earlier in the run.
    'false': 0
    'true': 50

  # Peaks
  enable_fundamental:
    # Enables Fundamentals book, items and collectibles
    'false': 0
    'true': 50

  enable_intermediate:
    # Enables Intermediate book, items and collectibles
    'false': 0
    'true': 50

  enable_advanced:
    # Enables Advanced book, items and collectibles
    'false': 0
    'true': 50

  enable_expert:
    # Enables Expert book, items and collectibles
    'false': 0
    'true': 50

  disable_solemn_tempest:
    # Removes Solemn Tempest from the locations pool, has no effect if **Enable Expert Peaks** is disabled
    'false': 0
    'true': 50

  include_free_solo:
    # Add Free Solo Peaks to the pool
    'false': 0
    'true': 50

  include_time_attack:
    # Adds beating peak time, hold and rope counts as checks
    'false': 0
    'true': 50

  # Item & Location Options
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with these items.
    {}

  start_inventory_from_pool:
    # Start with these items and don't place them in the world.
    # 
    # The game decides what the replacement items will be.
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []
